home *** CD-ROM | disk | FTP | other *** search
/ Logiciels PC Special 3 / Logiciel PC - Hors-Serie 3.iso / Logs / micros / ql / outils / qltoolsq / source / docs / qltools22.readme < prev    next >
Text File  |  1995-09-21  |  7KB  |  230 lines
  1. This file updates the QLtools documentation to v2.2 from v1.6. Note
  2. that I do not have access to v1.7 - v2.02 documentation (if any
  3. exists). The fixes/enhancements noted below are changes from the v2.02
  4. code.
  5.  
  6. Bug fixes/features in QLTOOLS 2.2
  7. =================================
  8.  
  9. 1. Format option now works
  10.  
  11. 2. HD disks now work
  12.  
  13. 3. Disk type QL5A/QL5B  recognition fixed.
  14.  
  15. 4. Random number is written when formatted.
  16.  
  17. 5. Update count is updated on write and delete
  18.  
  19. 6. Intel cross compiler files XTc68/Lux68 have the file type and data
  20.    size set.
  21.  
  22. 7. When Unix files are written, directory specs are removed and
  23.    any dots are replaced with '_'. DOS files have '.' replacement.
  24.  
  25. 8. I/O errors (e.g. write protected disk) trapped.
  26.  
  27. 9. Wildcard operation for write (under Unix).
  28.  
  29. 10. TKII type overwrite messages option.
  30.  
  31. 11. Segment fault (GPF) on map listing of disk with sub-directories
  32.     fixed.
  33.  
  34. 12. Range operations for read and delete.
  35.  
  36. 13. Read-only operations allowed on write protected disks.
  37.  
  38. 14. Problems writing files where the number of files was a multiple of
  39.     8 fixed. (v2.01 got the directory pointers wrong, so 8 files would
  40.     not be visible under QDOS). v2.1 got it wrong a different way :-).
  41.  
  42. 15. QLTools sets correct file date and updates file version when
  43.     writing.
  44.  
  45.  
  46. QLTools v2.2 Commands
  47. =====================
  48.  
  49. The full command options for QLTools are:
  50.  
  51.  qltools dev -opt <args>
  52.  
  53. where 
  54.     dev is the device.
  55.  
  56.     /dev/xxxx for Unix, for example
  57.     
  58.     /dev/fd0H720 (dd), /dev/fd0H1440 (hd) for Linux
  59.     fd=/dev/fd0H720
  60.     hd=/dev/fd0H1440
  61.     export fd
  62.     export hd
  63.     qltools $hd ..etc..
  64.  
  65.     This is a: or b: for DOS and siblings (NT,OS/2,Win95 etc)
  66.  
  67.     -opt <args> are command options.
  68.  
  69. -t    Toggles translation of foreign names to QDOS/SMS. Default is on.
  70.  
  71. -uN    Dump Cluster 'N' to stdout. N is 0-479 for dd, 0-959 for hd.
  72.  
  73. -d    Verbose directory listing
  74.  
  75. -dl    Verbose directory listing (includes deleted files)
  76.  
  77. -s    Short listing (suitable for Unix scripts)
  78.  
  79. -i    Return disk info
  80.  
  81. -m    Display disk map
  82.  
  83. -c    Display sector/cluster mapping table
  84.  
  85. -nX[-Y]    Copy file number X [to file no. Y inclusive] to stdout. See
  86.     viewall.sh and qlcopy.pl scripts; the -n is optional if no
  87.         other options are given.
  88.  
  89. -n file Copy file name 'file' to stdout
  90.  
  91. -W files
  92.     Copy files to disk, no prompt for overwrite.
  93. -w files
  94.     Copy files to disk, prompt for overwrite, like TKII does.
  95.  
  96.     Wildcards are supported where the shell provides wildcard
  97.         expansion (Unix).
  98.  
  99. -l      lists wild card files as written to QDOS disk (-w, -W).
  100.  
  101. -rX[-Y] Delete file number X [to file no. Y inclusive].
  102.  
  103. -r file Delete file name 'file'.
  104.  
  105. -xX N Set dataspace for file number X to N bytes
  106.  
  107. -x file N
  108.     Set dataspace for file name 'file' to N bytes.
  109.  
  110. -fXd name
  111.     Adds a QL format to a disk low-level formatted by DOS or Unix
  112.     (Linux fdformat).
  113.     Xd is dd for DD disk, hd for HD disks
  114.     name is the volume name
  115.  
  116. Note the syntax for options -n,-r,-x. Where there is a space after the
  117. option, then what follows is assumed to be a single file name. Where
  118. the paramter follows immediately, it is assumed to be a file number or
  119. range.
  120.  
  121. Qltools 2.1+ supports automatic setting of dataspace for executable
  122. files as follows.
  123.  
  124.     Where the executable file has been created with a c68
  125.     cross-compiler (XTc68 for DOS, OS/2 or NT, Lux68 for Linux),
  126.     then the dataspace is set automatically in the file header.
  127.  
  128.     Where normal QL executables are copied from a QDOS disk,
  129.     QLTools will append a XTc68 data block (8 bytes) to the end of
  130.     the file. When the executable is copied back to a QL disk,
  131.     then the dataspace is set from this block. Note that this
  132.     means that such files will experience a one off growth of 8
  133.     bytes. This minor increase in file size is considered
  134.     preferable (at least by JH) to the loss of such information.
  135.  
  136. Examples
  137. ========
  138.  
  139. qltools $fd -W ~/tmp/*.c    Copies all *.c files from the tmp
  140.                 sub-directory to a DD ql disk.
  141.                 The . is stored as _, directory suffix
  142.                 if disgarded. Any existing file is
  143.                 overwritten.
  144.  
  145. qltools $fd -t -w *.h        Copies all *.h files to a HD ql disk.
  146.                 The . is stored as .
  147.                 User is prompted for overwrite.
  148.  
  149. qltools $hd -r10-15        Deletes file numbers 10 to 15
  150.                 (inclusive)
  151.  
  152. qltools $fd -fdd plugh        Formats QL DD disk with label "plugh"
  153.  
  154.  
  155. qltools $fd file_txt        Copies QL file 'file_txt' to stdout
  156.  
  157.  
  158. Supplied files
  159. ==============
  160.  
  161. changes            Changes to v1.6 (gz)
  162. copyright        Copyright from v1.6 (gz)
  163. examples        v1.6 examples (gz)
  164. format            Notes on QL disk format (pf)
  165. qlcopy.pl        Perl script to copy files to Unix (jh)
  166. qltools            qltools image for Linux (jh)
  167. qltools.c        qltools v2.1 (jh,rz,vo,gz)
  168. qltools.exe        qltools image for DOS,NT,OS2,Win95 (jh)
  169. qltools21.readme    Documentation for v2.1 (jh)
  170. readme            Documentation for v1.6 (gz)
  171. viewall.sh        Viewer sh script (gz)
  172.  
  173. Credits are
  174.  
  175. gz    Giuseppe Zanetti    (original author)
  176. vo    Valenti Omar
  177. rz    Richard Zidlicky
  178. jh    Jonathan Hudson
  179.  
  180. Distribution conditions are vague, but generally GPL-ish. This is
  181. copyrighted free-ware.
  182.  
  183. The following, at least, admit to having had something to do with this
  184. program.
  185.  
  186. Giuseppe Zanetti  via Vergani, 11 - 35031 Abano Terme (Padova) ITALY
  187. e-mail: beppe@sabrina.dei.unipd.it
  188. Version 2.01:Valenti Omar, Via Statale 127, Casalgrande (RE)
  189. e-mail: sinf7@imovx2.unimo.it   sinf7@imoax1.unimo.it
  190. Version 2.02:Richard Zidlicky, rdzidlic@cip.informatik.uni-erlangen.de
  191. version 2.1: Jonathan Hudson, +968 699407 (voice/fax/data)
  192. version 2.2: Jonathan Hudson, +968 699407 (voice/fax/data)
  193.  
  194. I (jh) am very grateful to gz,vo,rz for their work on this extremely
  195. useful program and making the software freely distributable.
  196.  
  197. Disclaimer
  198. ==========
  199.  
  200. I have been able to test this mainly under Linux with DD disks. I know
  201. it can read DD disks written by a real QDOS compatible system, but at
  202. the time of writing, HD disks written by QLTools are untested on
  203. genuine hardware. The Linux version is compiled with gcc. The DOS et
  204. al version is a 16bit DOS image compiled with Watcom C/C++. It runs
  205. under DOS/NT/OS2/Win95.
  206.  
  207. The authors are not responsible for any consequences of using this
  208. software, including the complete loss of all your data. You use this
  209. at your own risk.
  210.  
  211. Bugs
  212. ====
  213.  
  214. Doesn't handle hard sub-directories. As I think I've worked out how
  215. these work, then the next release of QLtools may implement this.
  216.  
  217. Considers the update field at offset 0x10 to be a long word. It
  218. appears that some disk drivers consider this to be short. This is a
  219. feature.
  220.  
  221. Doesn't allow qdos/sms  file selection by wildcard, this would require
  222. escaping from the Unix shell.
  223.  
  224. Doesn't allow wildcards in DOS and siblings. This is a limitation of
  225. DOS et al.
  226.  
  227. Doesn't handle ED disks. This is not likely to be implemented.
  228.  
  229.  
  230.